Implement Keyring API v2 by jeremytsng · Pull Request #151 · MetaMask/snap-stellar-wallet

jeremytsng · 2026-07-02T08:43:54Z

Explanation

Migrates the Stellar snap's keyring handler onto the remaining MetaMask Keyring API v2 surface and adds private-key export:

Adds exportAccount — exports the raw ed25519 secret seed as hexadecimal (default) or base58, resolved through the existing AccountResolver. The exported value is validated with a boolean guard rather than an asserting one so a validation failure can never leak the key into an error message; the same value is redacted before it reaches the handler's debug log.
Adds getAccounts (delegates to listAccounts) and makes getAccount throw for an unknown id instead of returning undefined — this is a breaking change for any caller relying on the old undefined-on-missing behavior.
Switches the keyring dispatcher to @metamask/keyring-snap-sdk/v2 and implements KeyringRpc instead of Keyring.
Declares the v2 RPC permissions (GetAccounts, ExportAccount for the MetaMask origin only) and manifest endowment:keyring.capabilities (scopes, export formats, bip44).
Enables moduleResolution: bundler so the /v2 subpath types resolve. No platformVersion change was needed. One dependency-resolution bump was required: endowment:keyring.capabilities validation was only added in @metamask/snaps-utils@12.2.0, one minor above what snaps-cli's existing range resolved to, so an exact resolutions pin was added (a caret range resolves to a patch release that pulls in an unrelated major bump elsewhere in the graph, which the exact pin avoids).

Exported keys are raw 32-byte seed bytes (hex/base58), not the Stellar S… secret-seed format — that StrKey encoding isn't expressible through the v2 exportAccount contract (which only supports hexadecimal/base58 over raw bytes), so this export is not directly importable into wallets like Freighter or Lobstr. Flagging this as a known limitation rather than a gap in this PR; a StrKey-compatible export would need a separate, non-keyring-v2 mechanism.

References

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've communicated my changes to consumers by updating changelogs for packages I've changed
I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

socket-security · 2026-07-02T11:50:55Z

All alerts resolved. Learn more about Socket for GitHub.

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring alerts on:

@metamask/messenger@1.2.0
@metamask/approval-controller@9.0.2
@metamask/slip44@4.5.0
@metamask/snaps-utils@12.2.0
@metamask/permission-controller@12.3.0
ses@1.15.0
@metamask/base-controller@9.1.0
@metamask/json-rpc-engine@10.5.0
@metamask/controller-utils@11.20.0

View full report

jeremytsng · 2026-07-02T12:09:22Z

@SocketSecurity ignore-all

Copilot

Pull request overview

This PR migrates the Stellar snap’s keyring handler to the remaining MetaMask Keyring API v2 surface, adding support for getAccounts and secure private-key export via exportAccount, along with required permissions/manifest updates.

Changes:

Implemented Keyring API v2 semantics in the keyring handler (KeyringRpc), including getAccounts, exportAccount, and updated getAccount missing-id behavior.
Added wallet-level raw seed export helpers and tests for hex/base58 export round-trips.
Updated snap permissions/manifest and dependency resolution to support v2 types and keyring capabilities.

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
yarn.lock	Updates lockfile to reflect new/updated dependency graph needed for v2 support.
packages/snap/tsconfig.json	Enables `moduleResolution: bundler` (and `module: preserve`) to resolve `/v2` subpath types.
packages/snap/src/services/wallet/Wallet.ts	Adds `exportKey` for raw seed export in hex/base58.
packages/snap/src/services/wallet/Wallet.test.ts	Adds tests validating `exportKey` output and round-trip behavior.
packages/snap/src/permissions.ts	Adds v2 RPC method permissions (`GetAccounts`, `ExportAccount`) and updates selected method constants.
packages/snap/src/handlers/keyring/keyring.ts	Migrates dispatcher to `@metamask/keyring-snap-sdk/v2`, implements `KeyringRpc`, adds `getAccounts` + `exportAccount`, and redacts export results from debug logs.
packages/snap/src/handlers/keyring/keyring.test.ts	Updates tests for v2 dispatcher usage, new semantics, export behavior, and log redaction.
packages/snap/src/handlers/keyring/api.ts	Adds `Base58Struct` and handler-level request struct for `exportAccount`.
packages/snap/src/handlers/keyring/api.test.ts	Adds tests for `Base58Struct`.
packages/snap/src/context.ts	Wires `AccountResolver` into `KeyringHandler` construction.
packages/snap/snap.manifest.json	Declares keyring capabilities for scopes, private-key export formats, and bip44 features.
packages/snap/package.json	Adds `@scure/base` dependency for base58 encoding.
packages/snap/CHANGELOG.md	Documents added v2 functionality and the `getAccount` breaking change.
package.json	Pins `@metamask/snaps-utils` via `resolutions` to support capabilities validation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

stanleyyconsensys · 2026-07-31T06:24:54Z

+    return this.listAccounts();
  }

  async createAccount(options?: CreateAccountOptions): Promise<KeyringAccount> {


no longer needed

can also remove account service create()

stanleyyconsensys · 2026-07-31T06:32:33Z


  async getAccountBalances(
    accountId: string,
-    assets: KnownCaip19AssetIdOrSlip44Id[],


seem this change is no need?

stanleyyconsensys · 2026-07-31T06:32:51Z

  async resolveAccountAddress(
-    scope: KnownCaip2ChainId,
-    request: ResolveAccountAddressJsonRpcRequest,
+    scope: CaipChainId,


lets keep the type

stanleyyconsensys · 2026-07-31T09:04:35Z

-    return account ? this.#toKeyringAccount(account) : undefined;
-  }
-
-  async createAccount(options?: CreateAccountOptions): Promise<KeyringAccount> {


this is no longer need

stanleyyconsensys · 2026-07-31T09:08:19Z


-    return this.#handlers[method].handle(request);
+    return {
+      pending: false,


still have pending is false ?

stanleyyconsensys · 2026-07-31T09:08:33Z

-    scope: KnownCaip2ChainId,
-    request: ResolveAccountAddressJsonRpcRequest,
+    scope: CaipChainId,
+    request: JsonRpcRequest,


type still change?

stanleyyconsensys · 2026-07-31T09:17:53Z

-  KeyringRpcMethod.ListAccounts,
-  KeyringRpcMethod.GetAccount,
-  KeyringRpcMethod.CreateAccount,
-  KeyringRpcMethod.CreateAccounts,
-  KeyringRpcMethod.DeleteAccount,
-  KeyringRpcMethod.DiscoverAccounts,
-  KeyringRpcMethod.GetAccountBalances,
-  KeyringRpcMethod.SubmitRequest,


is that okay to remove those keyring method ? lets clarify with account team

stanleyyconsensys · 2026-07-31T09:21:42Z

it looks missing bip44?

stanleyyconsensys · 2026-07-31T12:55:09Z

  },
  "resolutions": {
    "@metamask/snaps-sdk": "11.1.1",
+    "@metamask/snaps-utils": "12.2.0",


this should not under resolution, or there are some special reason?

jeremytsng force-pushed the feat/stellar-keyring-v2 branch from 529fdab to 00fcbf1 Compare July 2, 2026 11:32

jeremytsng changed the title ~~Implement Keyring API v2 (private-key export)~~ Implement Keyring API v2 Jul 2, 2026

jeremytsng marked this pull request as ready for review July 2, 2026 11:46

jeremytsng requested a review from a team as a code owner July 2, 2026 11:46

jeremytsng force-pushed the feat/stellar-keyring-v2 branch from 00fcbf1 to 03fdea9 Compare July 2, 2026 11:50

Julink-eth requested a review from Copilot July 2, 2026 14:33

Copilot started reviewing on behalf of Julink-eth July 2, 2026 14:36 View session

Copilot AI reviewed Jul 2, 2026

View reviewed changes

Comment thread packages/snap/src/handlers/keyring/keyring.ts Outdated

jeremytsng force-pushed the feat/stellar-keyring-v2 branch from 03fdea9 to c267be1 Compare July 2, 2026 17:30

stanleyyconsensys reviewed Jul 3, 2026

View reviewed changes

Comment thread packages/snap/src/services/wallet/Wallet.ts Outdated

stanleyyconsensys reviewed Jul 3, 2026

View reviewed changes

Comment thread packages/snap/CHANGELOG.md Outdated

jeremytsng force-pushed the feat/stellar-keyring-v2 branch from c267be1 to 99030f1 Compare July 3, 2026 06:14

stanleyyconsensys reviewed Jul 3, 2026

View reviewed changes

Comment thread packages/snap/src/services/wallet/Wallet.test.ts Outdated

Comment thread packages/snap/src/handlers/keyring/keyring.ts Outdated

Comment thread packages/snap/src/handlers/keyring/api.ts Outdated

Comment thread packages/snap/src/handlers/keyring/keyring.ts Outdated

jeremytsng force-pushed the feat/stellar-keyring-v2 branch 3 times, most recently from 74127c4 to cd42af5 Compare July 31, 2026 06:06

jeremytsng requested a review from stanleyyconsensys July 31, 2026 06:07

jeremytsng force-pushed the feat/stellar-keyring-v2 branch from cd42af5 to d2f45f1 Compare July 31, 2026 06:24

stanleyyconsensys reviewed Jul 31, 2026

View reviewed changes

Comment thread packages/snap/src/handlers/keyring/keyring.ts Outdated

jeremytsng force-pushed the feat/stellar-keyring-v2 branch 5 times, most recently from c3cdaf2 to e36f177 Compare July 31, 2026 08:36

stanleyyconsensys reviewed Jul 31, 2026

View reviewed changes

Comment thread packages/snap/snap.manifest.json Outdated

stanleyyconsensys Jul 31, 2026

Copy link
Copy Markdown

Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it looks missing bip44?

jeremytsng force-pushed the feat/stellar-keyring-v2 branch 2 times, most recently from 2d4fac3 to cb7e0d6 Compare July 31, 2026 09:47

feat: migrate keyring handler to Keyring API v2

960162d

jeremytsng force-pushed the feat/stellar-keyring-v2 branch from cb7e0d6 to 960162d Compare July 31, 2026 11:22

stanleyyconsensys reviewed Jul 31, 2026

View reviewed changes

Uh oh!

Conversation

jeremytsng commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Checklist

Uh oh!

socket-security Bot commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeremytsng commented Jul 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stanleyyconsensys Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jeremytsng commented Jul 2, 2026 •

edited

Loading

socket-security Bot commented Jul 2, 2026 •

edited

Loading

stanleyyconsensys Jul 31, 2026 •

edited

Loading